Node / meshtastic / Meshtastic-Android / files / core / model / src / commonMain / kotlin / org / meshtastic / core / model / DataPacket.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.core.model

Tff7b72import T7ee787kotlinx.serialization.Serializable

Tff7b72import T7ee787okio.ByteString

Tff7b72import T7ee787okio.ByteString.Companion.toByteString

Tff7b72import T7ee787org.meshtastic.core.common.util.nowMillis

Tff7b72import T7ee787org.meshtastic.core.model.util.ByteStringSerializer

Tff7b72import T7ee787org.meshtastic.proto.MeshPacket

Tff7b72import T7ee787org.meshtastic.proto.PortNum

Tff7b72import T7ee787org.meshtastic.proto.Waypoint

Tff7b72enum Tff7b72class T56d364MessageStatus Tb4b4b4{

Te6edf3UNKNOWNTb4b4b4, T8b949e// Not set for this message

Te6edf3RECEIVEDTb4b4b4, T8b949e// Came in from the mesh

Te6edf3QUEUEDTb4b4b4, T8b949e// Waiting to send to the mesh as soon as we connect to the device

Te6edf3ENROUTETb4b4b4, T8b949e// Delivered to the radio, but no ACK or NAK received

Te6edf3DELIVEREDTb4b4b4, T8b949e// We received an ack

Te6edf3SFPP_ROUTINGTb4b4b4, T8b949e// Message is being routed/buffered in the SFPP system

Te6edf3SFPP_CONFIRMEDTb4b4b4, T8b949e// Message is confirmed on the SFPP chain

Te6edf3ERRORTb4b4b4, T8b949e// We received back a nak, message not delivered

Tb4b4b4}

T8b949e/** A data class version of the protobuf MeshPacket + Data subpacket. */

Tf0883e@Serializable

Tff7b72data Tff7b72class T56d364DataPacketTb4b4b4(

Tff7b72var Te6edf3toTb4b4b4: Tffa657String? Tff7b72= Te6edf3NodeAddressTb4b4b4.Te6edf3ID_BROADCASTTb4b4b4,

Tf0883e@SerializableTb4b4b4(Te6edf3with Tff7b72= Te6edf3ByteStringSerializerTff7b72::Te6edf3classTb4b4b4) Tff7b72var Te6edf3bytesTb4b4b4: Te6edf3ByteString?Tb4b4b4,

T8b949e// A port number for this packet

Tff7b72var Te6edf3dataTypeTb4b4b4: Tffa657IntTb4b4b4,

Tff7b72var Te6edf3fromTb4b4b4: Tffa657String? Tff7b72= Te6edf3NodeAddressTb4b4b4.Te6edf3ID_LOCALTb4b4b4,

Tff7b72var Te6edf3timeTb4b4b4: Tffa657Long Tff7b72= Te6edf3nowMillisTb4b4b4, T8b949e// msecs since 1970

Tff7b72var Te6edf3idTb4b4b4: Tffa657Int Tff7b72= T79c0ff0Tb4b4b4, T8b949e// 0 means unassigned

Tff7b72var Te6edf3statusTb4b4b4: Te6edf3MessageStatus? Tff7b72= Te6edf3MessageStatusTb4b4b4.Te6edf3UNKNOWNTb4b4b4,

Tff7b72var Te6edf3hopLimitTb4b4b4: Tffa657Int Tff7b72= T79c0ff0Tb4b4b4,

Tff7b72var Te6edf3channelTb4b4b4: Tffa657Int Tff7b72= T79c0ff0Tb4b4b4, T8b949e// channel index

Tff7b72var Te6edf3wantAckTb4b4b4: Tffa657Boolean Tff7b72= Tff7b72trueTb4b4b4, T8b949e// If true, the receiver should send an ack back

Tff7b72var Te6edf3hopStartTb4b4b4: Tffa657Int Tff7b72= T79c0ff0Tb4b4b4,

T8b949e/** Signal-to-noise ratio in dB, or null when the packet carried no measurement. 0 dB is a valid reading. */

Tff7b72var Te6edf3snrTb4b4b4: Tffa657Float? Tff7b72= Tff7b72nullTb4b4b4,

T8b949e/** Received signal strength, or null when the radio did not report one. 0 dBm is a valid reading. */

Tff7b72var Te6edf3rssiTb4b4b4: Tffa657Int? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72var Te6edf3replyIdTb4b4b4: Tffa657Int? Tff7b72= Tff7b72nullTb4b4b4, T8b949e// If this is a reply to a previous message, this is the ID of that message

Tff7b72var Te6edf3relayNodeTb4b4b4: Tffa657Int? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72var Te6edf3relaysTb4b4b4: Tffa657Int Tff7b72= T79c0ff0Tb4b4b4,

Tff7b72var Te6edf3viaMqttTb4b4b4: Tffa657Boolean Tff7b72= Tff7b72falseTb4b4b4, T8b949e// True if this packet passed via MQTT somewhere along its path

Tff7b72var Te6edf3emojiTb4b4b4: Tffa657Int Tff7b72= T79c0ff0Tb4b4b4,

Tf0883e@SerializableTb4b4b4(Te6edf3with Tff7b72= Te6edf3ByteStringSerializerTff7b72::Te6edf3classTb4b4b4) Tff7b72var Te6edf3sfppHashTb4b4b4: Te6edf3ByteString? Tff7b72= Tff7b72nullTb4b4b4,

T8b949e/** The transport mechanism this packet arrived over (see [MeshPacket.TransportMechanism]). */

Tff7b72var Te6edf3transportMechanismTb4b4b4: Tffa657Int Tff7b72= T79c0ff0Tb4b4b4,

T8b949e/** True when the radio verified this broadcast's XEdDSA signature ([MeshPacket.xeddsa_signed]). */

Tff7b72var Te6edf3xeddsaSignedTb4b4b4: Tffa657Boolean Tff7b72= Tff7b72falseTb4b4b4,

Tb4b4b4) Tb4b4b4{

T8b949e/** If there was an error with this message, this string describes what was wrong. */

Tff7b72var Te6edf3errorMessageTb4b4b4: Tffa657String? Tff7b72= Tff7b72null

T8b949e/** Syntactic sugar to make it easy to create text messages */

Tff7b72constructorTb4b4b4(

Te6edf3toTb4b4b4: Tffa657String?Tb4b4b4,

Te6edf3channelTb4b4b4: Tffa657IntTb4b4b4,

Te6edf3textTb4b4b4: Tffa657StringTb4b4b4,

Te6edf3replyIdTb4b4b4: Tffa657Int? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4) Tb4b4b4: Tff7b72thisTb4b4b4(

Te6edf3to Tff7b72= Te6edf3toTb4b4b4,

Te6edf3bytes Tff7b72= Te6edf3textTb4b4b4.Te6edf3encodeToByteArrayTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3toByteStringTb4b4b4(Tb4b4b4)Tb4b4b4,

Te6edf3dataType Tff7b72= Te6edf3PortNumTb4b4b4.Te6edf3TEXT_MESSAGE_APPTb4b4b4.Te6edf3valueTb4b4b4,

Te6edf3channel Tff7b72= Te6edf3channelTb4b4b4,

Te6edf3replyId Tff7b72= Te6edf3replyIdTb4b4b4,

Tb4b4b4)

T8b949e/** If this is a text message, return the string, otherwise null */

Tff7b72val Te6edf3textTb4b4b4: Tffa657String?

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72=

Tff7b72if Tb4b4b4(Te6edf3dataType Tff7b72=Tff7b72= Te6edf3PortNumTb4b4b4.Te6edf3TEXT_MESSAGE_APPTb4b4b4.Te6edf3valueTb4b4b4) Tb4b4b4{

Te6edf3bytesTff7b72?.Te6edf3utf8Tb4b4b4(Tb4b4b4)

Tb4b4b4} Tff7b72else Tb4b4b4{

Tff7b72null

Tb4b4b4}

Tff7b72val Te6edf3alertTb4b4b4: Tffa657String?

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72=

Tff7b72if Tb4b4b4(Te6edf3dataType Tff7b72=Tff7b72= Te6edf3PortNumTb4b4b4.Te6edf3ALERT_APPTb4b4b4.Te6edf3valueTb4b4b4) Tb4b4b4{

Te6edf3bytesTff7b72?.Te6edf3utf8Tb4b4b4(Tb4b4b4)

Tb4b4b4} Tff7b72else Tb4b4b4{

Tff7b72null

Tb4b4b4}

Tff7b72constructorTb4b4b4(

Te6edf3toTb4b4b4: Tffa657String?Tb4b4b4,

Te6edf3channelTb4b4b4: Tffa657IntTb4b4b4,

Te6edf3waypointTb4b4b4: Te6edf3WaypointTb4b4b4,

Tb4b4b4) Tb4b4b4: Tff7b72thisTb4b4b4(

Te6edf3to Tff7b72= Te6edf3toTb4b4b4,

Te6edf3bytes Tff7b72= Te6edf3WaypointTb4b4b4.Te6edf3ADAPTERTb4b4b4.Te6edf3encodeTb4b4b4(Te6edf3waypointTb4b4b4)Tb4b4b4.Te6edf3toByteStringTb4b4b4(Tb4b4b4)Tb4b4b4,

Te6edf3dataType Tff7b72= Te6edf3PortNumTb4b4b4.Te6edf3WAYPOINT_APPTb4b4b4.Te6edf3valueTb4b4b4,

Te6edf3channel Tff7b72= Te6edf3channelTb4b4b4,

Tb4b4b4)

Tff7b72val Te6edf3waypointTb4b4b4: Te6edf3Waypoint?

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72=

Tff7b72if Tb4b4b4(Te6edf3dataType Tff7b72=Tff7b72= Te6edf3PortNumTb4b4b4.Te6edf3WAYPOINT_APPTb4b4b4.Te6edf3valueTb4b4b4) Tb4b4b4{

Tff7b72try Tb4b4b4{

Te6edf3bytesTff7b72?.Te6edf3let Tb4b4b4{ Te6edf3WaypointTb4b4b4.Te6edf3ADAPTERTb4b4b4.Te6edf3decodeTb4b4b4(Tffa657itTb4b4b4) Tb4b4b4}

Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3eTb4b4b4: Te6edf3ExceptionTb4b4b4) Tb4b4b4{

Tff7b72null

Tb4b4b4}

Tb4b4b4} Tff7b72else Tb4b4b4{

Tff7b72null

Tb4b4b4}

Tff7b72val Te6edf3hopsAwayTb4b4b4: Tffa657Int

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Tff7b72if Tb4b4b4(Te6edf3hopStart Tff7b72=Tff7b72= T79c0ff0 Tff7b72|Tff7b72| Tb4b4b4(Te6edf3hopLimit Tff7b72> Te6edf3hopStartTb4b4b4)Tb4b4b4) Tff7b72-T79c0ff1 Tff7b72else Te6edf3hopStart Tff7b72- Te6edf3hopLimit

Tb4b4b4}